feat(doc): generate meta file#763
Conversation
c666b55 to
d4776b8
Compare
This comment was marked as resolved.
This comment was marked as resolved.
d4776b8 to
b0c5a5b
Compare
- Move `uv.spawn` `options` description into the param description.
2a303a9 to
4501268
Compare
4501268 to
c352e5b
Compare
|
Seems to be missing |
|
Yes, I chose not to generate these. For simple types they are inlined. --- @param stream uv.uv_stream_t
--- @param callback fun(err: string?, data: string?)
--- @return 0? success
--- @return string? err
--- @return string? err_name
function uv.read_start(stream, callback) end |
|
Ok, but that means these files are not drop-in replacements for https://github.com/LuaCATS/luv, and switching to them requires annotation changes in Neovim ( |
|
Yes. Providing a 100% drop-replacement for https://github.com/LuaCATS/luv was not my intended goal |
|
That's fair, but could you then make the goal explicit in the PR description (which I suspect is garbled; the second paragraph doesn't make sense to me)? |
|
I think the current PR description reflects the goal and makes no mention of https://github.com/LuaCATS/luv . However, I've added a note mentioning it is similar but different. |
|
cc @truemedian @squeek502 . Sorry to ping, any chance of a review? |
squeek502
left a comment
There was a problem hiding this comment.
docs.md changes look good, and I'm going to trust that the meta.lua file is useful for the intended use cases as I'm unfamiliar with LuaCATS.
Thanks!
This file adds additional logic to
docgen.luato generate a filemeta.luawhich is formatted with LuaCATs.For complex types, the script will automatically create either a
@classor@alias, and will be rendered near to their use.Note: This PR produces something similar to https://github.com/LuaCATS/luv, but not 100%. The main difference being that this PR generates significantly less
@classand@aliasnames.